Get debtors balance

Path: api/v1/accounts/debtors/balance/{cardno}

This endpoint supports the following methods:
GET

Summary: Returns debtors balance and currency code

Query Parameters

Parameter	Optional	Description
exclPrep	✓	Optional. Whether to exclude Job prepayments from the balance: true = exclude, false = include. Defaults to true (prepayments excluded).
currCode	✓	Optional parameter to get debtors balance for a specific currency

Response content

Attribute	Type	Description
balance	number	Returns debtors balance
cardNo	integer	Card number
currencyCode	string	Returns currency code of debtors balance

Example GET

Path: api/v1/accounts/debtors/balance/1?exclPrep=true

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

{
	"cardNo": 1,
	"balance": 10.0,
	"currencyCode": "AUD"
}